home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / maximus / mbank214.zip / MAXIBANK.DOC < prev    next >
Text File  |  1993-03-27  |  13KB  |  296 lines
  1.  
  2.  
  3.  
  4.  
  5.  
  6.  
  7.  
  8.  
  9.  
  10.  
  11.                                 MAXIBANK v2.14
  12.  
  13.                                 (c)1993 RAFware
  14.  
  15.                               (1:xxx/xxx)@Fidonet.org
  16.  
  17.  
  18.  
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25. -------------------------------------------------------------------------------
  26. DISCLAIMER
  27. -------------------------------------------------------------------------------
  28. Note: This documentation file was not written by the author of MaxiBank but
  29.       was written by Eric Mathurin, the first beta tester.
  30.  
  31. I don't claim that MaxiBank is  good  for  anything -- if  you think  it  is,
  32. great, but it's up to  you  to  decide.  If  MaxiBank  doesn't  work:  tough.
  33. If  you  lose  a  million because MaxiBank messes up, it's you that's out the
  34. million,  not me. If you don't like this  disclaimer:  tough   I  reserve the
  35. right to  do  the  absolute  minumum  provided  by  law,  up to and including
  36. nothing.
  37.  
  38. This is basically the same disclaimer that comes with  all software packages,
  39. but this is in plain English and other ones are in legalese.
  40.  
  41. -------------------------------------------------------------------------------
  42. WHAT IT DOES
  43. -------------------------------------------------------------------------------
  44.  
  45. Have your users ever complained that they don't have  enough  time?  Do  they
  46. ask for more time to download a massive file, or to  play  online  games?  If
  47. so, then your users will appreciate a 'time bank'.  What this  door  does  is
  48. allows a user to deposit time for later use.                        
  49.  
  50. -------------------------------------------------------------------------------
  51. FEATURES
  52. -------------------------------------------------------------------------------
  53.  
  54. - Allows deposits and withdrawls
  55. - Can give interest to users based on amount of time in their account
  56. - Allows a maximum amount of time to be withdrawn
  57. - Can be set to disallow withdrawls during certain hours
  58. - Built in 'Bank Manager' function
  59. - Allows 'Bonus' time for new accounts
  60. - Allows user to transfer time to any other user's account.
  61. - Will not let users overrun declared system events
  62. - Totally configurable, and easy to set up
  63. - Built in help screen for users, Simple ASCII text file you can create.
  64. - ANSI graphics available
  65. - AVATAR graphics to remote if user has AVATAR active. ANSI on local
  66. - Uses FOSSIL driver for remote communications.
  67. - ByteBank feature - user can reduce/erase their daily download amount.
  68.  
  69. -------------------------------------------------------------------------------
  70. HOW IT WORKS
  71. -------------------------------------------------------------------------------
  72.  
  73. The user loads  the bank door  and  deposits  some  of his online time.  This
  74. time is then stored in the bank account for  later use and is subtracted from
  75. his current online time.  The user may  then  call back at a later  date  and
  76. use  this  time  for  whatever  purposes he may have.  Essentially,  the user
  77. spends less time during one call, and more time during another call.
  78.  
  79. Also, the user has the ability to use the ByteBank.  Let's say the user down-
  80. loaded a 200K file, and has a 500K download limit.  Now he wants to  download
  81. a 400K file, but alas - he can't!  This is where the ByteBank comes  in.  All
  82. the user has to do is load MaxiBank and  choose  the  ByteBank  option.  Here
  83. the user can clear the amount of kilobytes he has used today by paying it off
  84. with his time.  MaxiBank calculates the  amount of time needed to pay off the
  85. bytes based  on the user's baud rate.  So, for  200K,  MaxiBank would ask the
  86. user to pay, let's say; 15 minutes (@ 2400 baud) to clear it.
  87.  
  88. -------------------------------------------------------------------------------
  89. REQUIREMENTS
  90. -------------------------------------------------------------------------------
  91.  
  92.  - Maximus CBCS
  93.  - MS-DOS v3.0 or higher
  94.  - ANSI.SYS or equivalent loaded.
  95.  - a FOSSIL (for online use).
  96.  - 142,000 bytes of free RAM.
  97.  
  98. ------------------------------------------------------------------------------
  99. IMPLEMENTATION
  100. ------------------------------------------------------------------------------
  101.  
  102. Setting  up  MaxiBank  is  pretty  easy.  For starters, just copy BANKER.EXE, 
  103. MAXIBANK.EXE  and   MAXIBANK.CFG   into  either  your  Maximus  directory  or
  104. any  other  directory.  Your  next  step  is  to  configure  MaxiBank.   This
  105. is done by  editing the  MAXIBANK.CFG  file  (it  contains  comments, so each
  106. option should be self-explanatory).      
  107.  
  108. You can call up MaxiBank from your MENUS.CTL by adding:
  109.  
  110.     ReRead Xtern_Run C:\Max\MaxiBank.Exe <options>   Normal "$)Time Bank"
  111.  
  112. You can also call MaxiBank up from a BBS file like this:   
  113.  
  114.     [Xtern_Run]@C:\Max\MaxiBank.Exe <option>
  115.  
  116.                ^ Tells Maximus to re-read the LASTUSER.BBS upon reloading.
  117.  
  118. Note: This program will *NOT* work in an External Errorlevel Exit from
  119.       Maximus.
  120.  
  121. ------------------------------------------------------------------------------
  122. COMMAND LINE SWITCHES
  123. ------------------------------------------------------------------------------
  124.  
  125. MaxiBank supports the following switches, which will override  the  settings
  126. inside of MAXIBANK.CFG (all switches are optional; if you load MaxiBank with
  127. no arguments it will use the settings in the CFG file).
  128.  
  129. Usage:  MaxiBank <options>
  130.  
  131. Where <options> are:
  132.  
  133. /C<filename>       - name of configuration file to use              
  134. /T<#>              - Maximus task number to use                
  135. /P<#>              - COMM port to use (COM1 = 1, COM2 = 2, etc) 
  136. /E                 - starts MaxiBank up in LOCAL Bank Manager mode
  137. /L<filename>       - specify MaxiLog filename, overrides .CFG option
  138. /D#                - Deletes inactive accounts, # = days of inactivty
  139.                    - Reports deletions in MaxiLog, and returns to DOS
  140.                    - /L option must come before any /D# options.
  141.  
  142. For example, a multi-line system might look like:
  143.  
  144.    MaxiBank.Exe /Cc:\max\bank1.cfg /T1 /P2
  145.  
  146. ------------------------------------------------------------------------------
  147. BANKER.EXE
  148. ------------------------------------------------------------------------------
  149.  
  150. You MUST run BANKER.EXE after each caller so that  the TIME ONTODAY field in
  151. the USER.BBS is  adjusted  according  the  amount  of time that the user has
  152. deposited in his account.  If the user didn't deposit any time, then nothing
  153. will be changed.  This  is  done so that the user can't call back and exceed
  154. his daily accumulated time limit. I  prefer not  to fiddle  with  this while
  155. Maximus is active.  Max v1.02  did not allow  any changes to the TimeOnToday
  156. value and Max v2.00 has gone berserk internally  with regards to this value.
  157. Running Banker after every  logoff takes about 2 seconds if no  transactions
  158. have occured. Less time on speady drives. Much less than ScanBld etc...
  159.  
  160. BANKER supports the following options (if none are  specified,  then  Banker 
  161. will assume the default names, and will look in the current directory):
  162.  
  163. Usage:  Banker <datafile> <userfile> <logfile>
  164.  
  165. <datafile>         - the filename and the directory that your bank DAT
  166.                      file resides in    
  167.  
  168. <userfile>         - the filename and path of your Maximus USER.BBS file
  169.  
  170. <logfile>          - name of the logfile for BANKER to write to
  171.  
  172. Example: 
  173.  
  174.     Banker.Exe C:\Max\MaxiBank.DAT C:\Max\User.BBS C:\Max\Max.LOG
  175.  
  176.  
  177. BANKER v2.14ß a MaxiBank utility. Adjusts TimeOnToday.
  178.  
  179. Usage: BANKER /B<bankfile> /U<userfile> /L<logfile> @<textfile>
  180.  
  181. /B<bankfile>  = path/filename of the  MaxiBank  data file.
  182.                 defaults to MAXIBANK.DAT
  183. /U<userfile>  = path/filename  of the  Maximus USER  file.
  184.                 defaults to USER.BBS
  185. /L<logfile>   = path/filename of a Maximus CBCS style log
  186.                 file NO default.
  187. @             = global function NOT to subtract withdrawal
  188.                 from User's TimeOn Today.
  189. @[textfile]   = Check TEXTFILE for a list of user names to
  190.                 apply the @ option.
  191.  
  192. Note: the v1.02  commandline "Banker <bankfile> <userfile> <logfile>"
  193.       is still valid, but to access the new IGNORE withdrawal option
  194.       requires you specify  the correct  switches and filenames. The
  195.       "/Llogfile" and "@textfile" have no default names.
  196.  
  197. eg: "Banker @baduser.txt /lmax.log"  look up bad names in baduser.txt
  198.      if match found then IGNORE withdrawal, log good users in max.log.
  199.      since "/B" and "/U" not specified, use defaults.
  200.  
  201. ------------------------------------------------------------------------------
  202. USING MAXIBANK
  203. ------------------------------------------------------------------------------
  204.  
  205. When you first run MaxiBank, it will create it's data file and will award
  206. users that  open  a new account with the amount specified in the CFG file
  207. and deposit  it  into his account.  The  user  is then presented with the 
  208. following options, all of which are quite self-explanatory:
  209.  
  210.         D)eposit, W)ithdrawl, T)ransfer, B)yteBank and Q)uit ?
  211.  
  212.  
  213. If there is an impending event, or if the user is  not  allowed  to  make
  214. withdrawls, then the W)ithdrawl option will  not be available.   Also, if
  215. the user has not downloaded any files, then the ByteBank  option will not
  216. be there either. Users can Transfer Time from their account  to any other
  217. users' account.
  218.  
  219. Note: The T)ransfer option will only be available  if the user has an
  220.       active account.  It will not be  available to first time users,
  221.       unless they withdraw or deposit time.
  222.  
  223.       B)yteBank will not be  available to users  without deposits and
  224.       will not  be available to first  time callers  unless you award
  225.       them with a "NewAccount" value greater than zero. (the default).
  226.  
  227.  
  228. If the user does not make any  transactions,  then  no  account  will  be 
  229. created.  This is useful if you just want to use the manager fuction, but
  230. do not wish to have an account.
  231.  
  232. If your username matches that of the name specified for 'Bank Manager' in
  233. the CFG file then the following options will  be  available  through  the 
  234. 'E)dit' command which will also appear at the Main Menu:
  235.  
  236.    N)ext, L)ist, P)revious, F)ind, J)ump, S)ort, E)dit, Q)uit ?
  237.  
  238. The user records will be displayed in the following form:
  239.  
  240. Account # 2.   First Last                       21 Jan 91 00:00:00    30
  241.  
  242.           ^ Record#   ^ User Name           Last visit ^      Minutes ^
  243.                                                 (Date)         (Time)
  244.  
  245. By choosing the 'E)dit' command from the Edit Menu, the following commands
  246. will be available to you:
  247.  
  248.    N)ame, D)ate, B)alance, H)ide, M)ark, P)urge, A)dd, L)evels, Q)uit ?
  249.  
  250. All  are self-explanatory, except for the 'M)ark' command.  This  allows you
  251. to tag  user names for  deletion.  Note,  you  will  not  be  able  to  edit 
  252. anything in account '0' except for 'balance' (total number of transactions).
  253. 'P)urge' allows you to 'M)ark'  accounts by number of days of inactivty. The
  254. S)ort command  allows you to selectively sort the data file by Name, Date or
  255. time in users' account.  Prefix your sort selection with a '-' for a reverse
  256. direction sort. The H)ide command makes this account perminent. All attempts
  257. to M)ark or P)urge will be ignored.  Un H)ide if you want to M)ark.  L)evels
  258. will display the privilege level of the current user and the account limits.
  259. If you are  looking  at the very  first record, the MaxiBank logo, then this
  260. option will list all privileges and the limits. These limit values cannot be
  261. changed while in editor mode, you  must edit Maxibank.Cfg,  this option only
  262. displays the values found in MaxiBank.Cfg.
  263.  
  264. ------------------------------------------------------------------------------
  265. SAMPLE BBS FILE
  266. ------------------------------------------------------------------------------
  267.  
  268. On my system, I load MaxiBank through a BBS file.  This is what my BANK.BBS
  269. file looks like:
  270.  
  271. [cls][ckoff][moreoff]
  272. [dbelow][white]Sorry, you must be registered to use this function. [quit]
  273. [gray][xtern_run]@c:\max\maxibank.exe /T%k /P%P
  274. [white][enter][cls][quit]
  275.  
  276. As you can see, I restrict the use of MaxiBank to users with Normal access
  277. or higher.  Note the '@' after the [xtern_run]  token;  this tells Maximus
  278. to re-read the LASTUSER.BBS file.
  279.  
  280. ------------------------------------------------------------------------------
  281. SUPPORT
  282. ------------------------------------------------------------------------------
  283.  
  284. You can reach the author of MaxiBank, Rodney Fraser, at 1:153/715 (FidoNet).
  285.  
  286. You can always file request the latest version of MaxiBank from the following
  287. address:
  288.  
  289. request Magic filename MAXIBANK
  290.  
  291.             1:153/715, HST speeds.
  292.  
  293. Enjoy!
  294.  
  295.  
  296.